Some documentation updates
authorMatthias Clasen <mclasen@redhat.com>
Mon, 30 Oct 2017 22:58:05 +0000 (18:58 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 30 Oct 2017 22:59:41 +0000 (18:59 -0400)
Document gtk_settings_get_for_display instead of for_screen.

docs/reference/gtk/gtk4-sections.txt
gtk/gtksettings.c

index 5768d2ccbb4a34472e03f0540d02eebfa9877a37..0159e8e277d3ffa732c4883685a09540f38a6793 100644 (file)
@@ -2642,6 +2642,7 @@ GtkSettings
 GtkSettingsValue
 gtk_settings_get_default
 gtk_settings_get_for_screen
+gtk_settings_get_for_display
 gtk_rc_property_parse_color
 gtk_rc_property_parse_enum
 gtk_rc_property_parse_flags
index 94c4c83dcd3eea28e7ef1089502193c7f66825d0..0426ab46db69b72e9427a62865aed445a4be7b15 100644 (file)
  *   g_object_set (gtk_settings_get_default (), "gtk-enable-animations", FALSE, NULL);
  * ]|
  *
- * There is one GtkSettings instance per screen. It can be obtained with
- * gtk_settings_get_for_screen(), but in many cases, it is more convenient
+ * There is one GtkSettings instance per display. It can be obtained with
+ * gtk_settings_get_for_display(), but in many cases, it is more convenient
  * to use gtk_widget_get_settings(). gtk_settings_get_default() returns the
- * GtkSettings instance for the default screen.
+ * GtkSettings instance for the default display.
  */
 
 
@@ -1247,6 +1247,16 @@ gtk_settings_create_for_display (GdkDisplay *display)
   return settings;
 }
 
+/**
+ * gtk_settings_get_for_display:
+ * @screen: a #GdkDisplay
+ *
+ * Gets the #GtkSettings object for @display, creating it if necessary.
+ *
+ * Returns: (transfer none): a #GtkSettings object.
+ *
+ * Since: 3.94
+ */
 GtkSettings *
 gtk_settings_get_for_display (GdkDisplay *display)
 {
@@ -1288,11 +1298,11 @@ gtk_settings_get_for_screen (GdkScreen *screen)
 /**
  * gtk_settings_get_default:
  *
- * Gets the #GtkSettings object for the default GDK screen, creating
- * it if necessary. See gtk_settings_get_for_screen().
+ * Gets the #GtkSettings object for the default display, creating
+ * it if necessary. See gtk_settings_get_for_display().
  *
  * Returns: (nullable) (transfer none): a #GtkSettings object. If there is
- * no default screen, then returns %NULL.
+ * no default display, then returns %NULL.
  **/
 GtkSettings*
 gtk_settings_get_default (void)